Triggered Action Type - Invoke Connector

The Invoke Connector Triggered Action type allows you to use a Connection Profile to send an API request to an external platform. For more information on Connection Profiles, see Getting Started with Connectors.

This Action has the following parameters:

  • Connector: Select the Connector type: Salesforce, Oracle Responsys, or Sparkfly.

  • Connection Profile: Select the desired Connection Profile of the type selected above.

  • Method: Select an HTTP method: GET, PUT, POST, or DELETE.

  • URL: Enter the webhook endpoint.

URL Parameters

The URL Parameters section is used to enter Path parameters that appear within the endpoint URL, but before any Query parameters (that is, before the question mark). To define URL parameters, click Add within the URL Parameters section, then enter the following information: 

  • Check Enabled.

  • Within the Name , enter the name of the parameter.

  • In the Value field, enter either:

    • A static value. Ensure that Static is checked.

    • A Content Token or Groovy expression to select or derive a value. In this scenario, uncheck Static. 

  • From the Data Type drop-down menu, select the parameter's data type: String, Integer, Decimal, or Boolean.

Repeat this step as needed to define additional URL parameters. To remove a parameter, click the Delete icon next to it.

Query Parameters

The Query Parameters section is used to enter Query parameters that appear after a question mark (?) in the endpoint. Each parameter is listed one right after the other with an ampersand (&) separating them. To define Query parameters, click Add within the Query Parameters section, then enter the following information: 

  • Check Enabled.

  • Within the Name , enter the name of the parameter.

  • In the Value field, enter either:

    • A static value. Ensure that Static is checked.

    • A Content Token or Groovy expression to select or derive a value. In this scenario, uncheck Static. 

  • From the Data Type drop-down menu, select the parameter's data type: String, Integer, Decimal, or Boolean.

Note: Query parameters must be included within the URL field above. The syntax is to use a percentage sign (%) followed by the parameter Name in curly brackets. For example: https://webhook.com/services/SearchRecords?member_id=%{id}

Repeat this step as needed to define additional Query parameters. To remove a parameter, click the Delete icon next to it.

Request Headers

Header parameters are included in the request header. Usually, the header includes authorization parameters. To define Header parameters, click Add within the Request Headers section, then enter the following information: 

  • Check Enabled.

  • Within the Name , enter the name of the parameter.

  • In the Value field, enter either:

    • A static value. Ensure that Static is checked.

    • A Content Token or Groovy expression to select or derive a value. In this scenario, uncheck Static. 

  • From the Data Type drop-down menu, select the parameter's data type: String, Integer, Decimal, or Boolean.

Repeat this step as needed to define additional Header parameters. To remove a parameter, click the Delete icon next to it.

Body Parameters

Frequently, Webhook calls include a JSON object in the request body, consisting of one or more key / value pairs. When defining the Request Body parameters, the platform allows you to enter these key / value pairs directly into the user interface. Optionally, you can also enter the "raw" JSON object. If you don't submit the raw JSON object, the platform submits the request as form data. 

Please note that in order to include double-quotes in a JSON value, you must escape the double-quote with a backslash. For example:

{"test": "<strong style=\"font-style: italic\">Hello World</strong>"}

To define Request Body parameters, click Add within the Form-Data / Request Body section, then enter the following information

  • Check Enabled.

  • Within the Name , enter the name of the parameter.

  • In the Value field, enter the parameter value.

Repeat this step as needed to define additional Body parameters. To remove a parameter, click the Delete icon next to it.

Optionally, to enter the raw JSON object, enter the JSON object within the Request Body field.